<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbrush: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp-data.html" title="Data Objects">
<link rel="next" href="libgimp3-gimpbrushes.html" title="gimpbrushes">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpbrush.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-data.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimpbrushes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpbrush"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpbrush.top_of_page"></a>gimpbrush</span></h2>
<p>gimpbrush — Functions operating on a single brush.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpbrush.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-new" title="gimp_brush_new ()">gimp_brush_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-duplicate" title="gimp_brush_duplicate ()">gimp_brush_duplicate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-rename" title="gimp_brush_rename ()">gimp_brush_rename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-delete" title="gimp_brush_delete ()">gimp_brush_delete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-info" title="gimp_brush_get_info ()">gimp_brush_get_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-pixels" title="gimp_brush_get_pixels ()">gimp_brush_get_pixels</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-spacing" title="gimp_brush_get_spacing ()">gimp_brush_get_spacing</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-spacing" title="gimp_brush_set_spacing ()">gimp_brush_set_spacing</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/libgimpbase3-gimpbaseenums.html#GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-shape" title="gimp_brush_get_shape ()">gimp_brush_get_shape</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/libgimpbase3-gimpbaseenums.html#GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-shape" title="gimp_brush_set_shape ()">gimp_brush_set_shape</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-spikes" title="gimp_brush_get_spikes ()">gimp_brush_get_spikes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-spikes" title="gimp_brush_set_spikes ()">gimp_brush_set_spikes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-angle" title="gimp_brush_get_angle ()">gimp_brush_get_angle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-angle" title="gimp_brush_set_angle ()">gimp_brush_set_angle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-radius" title="gimp_brush_get_radius ()">gimp_brush_get_radius</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-radius" title="gimp_brush_set_radius ()">gimp_brush_set_radius</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-aspect-ratio" title="gimp_brush_get_aspect_ratio ()">gimp_brush_get_aspect_ratio</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-aspect-ratio" title="gimp_brush_set_aspect_ratio ()">gimp_brush_set_aspect_ratio</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-get-hardness" title="gimp_brush_get_hardness ()">gimp_brush_get_hardness</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-set-hardness" title="gimp_brush_set_hardness ()">gimp_brush_set_hardness</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-is-generated" title="gimp_brush_is_generated ()">gimp_brush_is_generated</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpbrush.html#gimp-brush-is-editable" title="gimp_brush_is_editable ()">gimp_brush_is_editable</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpbrush.description"></a><h2>Description</h2>
<p>Functions operating on a single brush.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpbrush.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-brush-new"></a><h3>gimp_brush_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_brush_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Creates a new brush.</p>
<p>This procedure creates a new, uninitialized brush.</p>
<div class="refsect3">
<a name="gimp-brush-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The requested name of the new brush.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-new.returns"></a><h4>Returns</h4>
<p>The actual new brush name.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-duplicate"></a><h3>gimp_brush_duplicate ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_brush_duplicate (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Duplicates a brush.</p>
<p>This procedure creates an identical brush by a different name.</p>
<div class="refsect3">
<a name="gimp-brush-duplicate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-duplicate.returns"></a><h4>Returns</h4>
<p>The name of the brush's copy.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-rename"></a><h3>gimp_brush_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_brush_rename (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                   <em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);</pre>
<p>Renames a brush.</p>
<p>This procedure renames a brush.</p>
<div class="refsect3">
<a name="gimp-brush-rename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_name</p></td>
<td class="parameter_description"><p>The new name of the brush.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-rename.returns"></a><h4>Returns</h4>
<p>The actual new name of the brush.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-delete"></a><h3>gimp_brush_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_delete (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Deletes a brush.</p>
<p>This procedure deletes a brush.</p>
<div class="refsect3">
<a name="gimp-brush-delete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-delete.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-info"></a><h3>gimp_brush_get_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_get_info (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                     <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
                     <em class="parameter"><code><span class="type">gint</span> *height</code></em>,
                     <em class="parameter"><code><span class="type">gint</span> *mask_bpp</code></em>,
                     <em class="parameter"><code><span class="type">gint</span> *color_bpp</code></em>);</pre>
<p>Retrieves information about the specified brush.</p>
<p>This procedure retrieves information about the specified brush:
brush extents (width and height), color depth and mask depth.</p>
<div class="refsect3">
<a name="gimp-brush-get-info.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The brush width. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The brush height. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>mask_bpp</p></td>
<td class="parameter_description"><p>The brush mask bpp. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>color_bpp</p></td>
<td class="parameter_description"><p>The brush color bpp. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-info.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-pixels"></a><h3>gimp_brush_get_pixels ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_get_pixels (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *height</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *mask_bpp</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *num_mask_bytes</code></em>,
                       <em class="parameter"><code><span class="type">guint8</span> **mask_bytes</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *color_bpp</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> *num_color_bytes</code></em>,
                       <em class="parameter"><code><span class="type">guint8</span> **color_bytes</code></em>);</pre>
<p>Retrieves information about the specified brush.</p>
<p>This procedure retrieves information about the specified brush. This
includes the brush extents (width and height) and its pixels data.</p>
<div class="refsect3">
<a name="gimp-brush-get-pixels.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The brush width. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The brush height. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>mask_bpp</p></td>
<td class="parameter_description"><p>The brush mask bpp. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>num_mask_bytes</p></td>
<td class="parameter_description"><p>Length of brush mask data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>mask_bytes</p></td>
<td class="parameter_description"><p>The brush mask data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_mask_bytes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>color_bpp</p></td>
<td class="parameter_description"><p>The brush color bpp. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>num_color_bytes</p></td>
<td class="parameter_description"><p>Length of brush color data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>color_bytes</p></td>
<td class="parameter_description"><p>The brush color data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_color_bytes][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-pixels.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-spacing"></a><h3>gimp_brush_get_spacing ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_get_spacing (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                        <em class="parameter"><code><span class="type">gint</span> *spacing</code></em>);</pre>
<p>Gets the brush spacing.</p>
<p>This procedure returns the spacing setting for the specified brush.
The return value is an integer between 0 and 1000 which represents
percentage of the maximum of the width and height of the mask.</p>
<div class="refsect3">
<a name="gimp-brush-get-spacing.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>The brush spacing. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-spacing.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-spacing"></a><h3>gimp_brush_set_spacing ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_set_spacing (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                        <em class="parameter"><code><span class="type">gint</span> spacing</code></em>);</pre>
<p>Sets the brush spacing.</p>
<p>This procedure modifies the spacing setting for the specified brush.
The value should be a integer between 0 and 1000.</p>
<div class="refsect3">
<a name="gimp-brush-set-spacing.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>The brush spacing.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-spacing.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-shape"></a><h3>gimp_brush_get_shape ()</h3>
<pre class="programlisting"><a href="../html/libgimpbase3-gimpbaseenums.html#GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a>
gimp_brush_get_shape (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the shape of a generated brush.</p>
<p>This procedure gets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
in the future.</p>
<div class="refsect3">
<a name="gimp-brush-get-shape.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-shape.returns"></a><h4>Returns</h4>
<p> The brush shape.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-shape"></a><h3>gimp_brush_set_shape ()</h3>
<pre class="programlisting"><a href="../html/libgimpbase3-gimpbaseenums.html#GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a>
gimp_brush_set_shape (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                      <em class="parameter"><code><a href="../html/libgimpbase3-gimpbaseenums.html#GimpBrushGeneratedShape"><span class="type">GimpBrushGeneratedShape</span></a> shape_in</code></em>);</pre>
<p>Sets the shape of a generated brush.</p>
<p>This procedure sets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
in the future.</p>
<div class="refsect3">
<a name="gimp-brush-set-shape.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>shape_in</p></td>
<td class="parameter_description"><p>The brush shape.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-shape.returns"></a><h4>Returns</h4>
<p> The brush shape actually assigned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-spikes"></a><h3>gimp_brush_get_spikes ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_brush_get_spikes (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the number of spikes for a generated brush.</p>
<p>This procedure gets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-get-spikes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-spikes.returns"></a><h4>Returns</h4>
<p> The number of spikes on the brush.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-spikes"></a><h3>gimp_brush_set_spikes ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_brush_set_spikes (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                       <em class="parameter"><code><span class="type">gint</span> spikes_in</code></em>);</pre>
<p>Sets the number of spikes for a generated brush.</p>
<p>This procedure sets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-set-spikes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spikes_in</p></td>
<td class="parameter_description"><p>The desired number of spikes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-spikes.returns"></a><h4>Returns</h4>
<p> The number of spikes actually assigned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-angle"></a><h3>gimp_brush_get_angle ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_get_angle (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the rotation angle of a generated brush.</p>
<p>This procedure gets the angle of rotation for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-get-angle.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-angle.returns"></a><h4>Returns</h4>
<p> The rotation angle of the brush in degree.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-angle"></a><h3>gimp_brush_set_angle ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_set_angle (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                      <em class="parameter"><code><span class="type">gdouble</span> angle_in</code></em>);</pre>
<p>Sets the rotation angle of a generated brush.</p>
<p>This procedure sets the rotation angle for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-set-angle.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>angle_in</p></td>
<td class="parameter_description"><p>The desired brush rotation angle in degree.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-angle.returns"></a><h4>Returns</h4>
<p> The brush rotation angle actually assigned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-radius"></a><h3>gimp_brush_get_radius ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_get_radius (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the radius of a generated brush.</p>
<p>This procedure gets the radius value for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-get-radius.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-radius.returns"></a><h4>Returns</h4>
<p> The radius of the brush in pixels.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-radius"></a><h3>gimp_brush_set_radius ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_set_radius (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                       <em class="parameter"><code><span class="type">gdouble</span> radius_in</code></em>);</pre>
<p>Sets the radius of a generated brush.</p>
<p>This procedure sets the radius for a generated brush. If called for
any other type of brush, it does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-set-radius.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>radius_in</p></td>
<td class="parameter_description"><p>The desired brush radius in pixel.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-radius.returns"></a><h4>Returns</h4>
<p> The brush radius actually assigned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-aspect-ratio"></a><h3>gimp_brush_get_aspect_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_get_aspect_ratio (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the aspect ratio of a generated brush.</p>
<p>This procedure gets the aspect ratio of a generated brush. If called
for any other type of brush, it does not succeed. The return value
is a float between 0.0 and 1000.0.</p>
<div class="refsect3">
<a name="gimp-brush-get-aspect-ratio.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-aspect-ratio.returns"></a><h4>Returns</h4>
<p> The aspect ratio of the brush.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-aspect-ratio"></a><h3>gimp_brush_set_aspect_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_set_aspect_ratio (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                             <em class="parameter"><code><span class="type">gdouble</span> aspect_ratio_in</code></em>);</pre>
<p>Sets the aspect ratio of a generated brush.</p>
<p>This procedure sets the aspect ratio for a generated brush. If
called for any other type of brush, it does not succeed. The value
should be a float between 0.0 and 1000.0.</p>
<div class="refsect3">
<a name="gimp-brush-set-aspect-ratio.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>aspect_ratio_in</p></td>
<td class="parameter_description"><p>The desired brush aspect ratio.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-aspect-ratio.returns"></a><h4>Returns</h4>
<p> The brush aspect ratio actually assigned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-hardness"></a><h3>gimp_brush_get_hardness ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_get_hardness (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the hardness of a generated brush.</p>
<p>This procedure gets the hardness of a generated brush. The hardness
of a brush is the amount its intensity fades at the outside edge, as
a float between 0.0 and 1.0. If called for any other type of brush,
the function does not succeed.</p>
<div class="refsect3">
<a name="gimp-brush-get-hardness.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-get-hardness.returns"></a><h4>Returns</h4>
<p> The hardness of the brush.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-hardness"></a><h3>gimp_brush_set_hardness ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gimp_brush_set_hardness (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                         <em class="parameter"><code><span class="type">gdouble</span> hardness_in</code></em>);</pre>
<p>Sets the hardness of a generated brush.</p>
<p>This procedure sets the hardness for a generated brush. If called
for any other type of brush, it does not succeed. The value should
be a float between 0.0 and 1.0.</p>
<div class="refsect3">
<a name="gimp-brush-set-hardness.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hardness_in</p></td>
<td class="parameter_description"><p>The desired brush hardness.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-set-hardness.returns"></a><h4>Returns</h4>
<p> The brush hardness actually assigned.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-is-generated"></a><h3>gimp_brush_is_generated ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_is_generated (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Tests if brush is generated.</p>
<p>Returns TRUE if this brush is parametric, FALSE for other types.</p>
<div class="refsect3">
<a name="gimp-brush-is-generated.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-is-generated.returns"></a><h4>Returns</h4>
<p> TRUE if the brush is generated.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-is-editable"></a><h3>gimp_brush_is_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_brush_is_editable (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Tests if brush can be edited.</p>
<p>Returns TRUE if you have permission to change the brush.</p>
<div class="refsect3">
<a name="gimp-brush-is-editable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The brush name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-is-editable.returns"></a><h4>Returns</h4>
<p> TRUE if the brush can be edited.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>